/*
 * Copyright 2025 The Netty Project
 *
 * The Netty Project licenses this file to you under the Apache License,
 * version 2.0 (the "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at:
 *
 *   https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 *
 */

package io.netty5.buffer.memseg;

import java.lang.foreign.MemorySegment;

/**
 * Allocator for a memory segment.
 */
@FunctionalInterface
interface DirectSegmentAllocator {

    /**
     * Allocates a direct memory segment with the given byte size.
     * @param byteSize The byte size to allocate.
     * @return A holder to get and free the allocated segment.
     */
    SegmentHolder allocate(long byteSize);

    /**
     * Holder for an allocated memory segment which can be freed.
     */
    interface SegmentHolder {

        /**
         * Get the allocated segment.
         * @return The allocated segment.
         */
        MemorySegment segment();

        /**
         * Frees the allocated segment.
         */
        void free();
    }
}
